Create App Environment

Creates a new application environment under the specified Project.

POST{accelqLoginUrl}/awb/api/2.0/{tenantCode}/{projectCode}/conf/app-environments

Headers

HeaderValue
user_idLogin username (email)
api_keyAPI key of the user for authentication
Content-Typeapplication/json
Acceptapplication/json

Parameters

ParameterTypeRequiredDescription
accelqLoginUrlstringYesThe AccelQ login URL for API access.
tenantCodestringYesTenant code for identifying the organization.
projectCodestringYesProject Code found under Auth properties of ACCELQ User Profile
user_idstringYesLogin username (email)
api_keystringYesAPI key of the user for authentication

Request Body

json
{
  "appEnvironmentName": "New App Environment",
  "description": "Description for the new app environment"
}

Responses

201 - App Environment successfully created.

json
{
  "pid": 15754,
  "appEnvironmentName": "New App Environment",
  "description": "Description for the new app environment"
}

400 - Bad Request Error

json
{
  "error": "Only alphabet, number, space, period and underscore are allowed in App Environment name."
}

403 - Forbidden - User does not have permission to create app environment

json
{
  "error": "User do not have authorization to access this feature."
}

422 - Project not found.

json
{
  "error": "Project with code 'proj123' not found."
}

cURL Command Builder

URL Parameters

Headers

Request Sample (cURL)

curl -X POST "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/${{projectCode}}/conf/app-environments" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "appEnvironmentName": "New App Environment",
  "description": "Description for the new app environment"
}'